<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>imaplib.IMAP4_stream</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        imaplib ::
        IMAP4_stream ::
        Class&nbsp;IMAP4_stream
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="imaplib.IMAP4_stream-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class IMAP4_stream</h1><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
<a href="imaplib.IMAP4-class.html">IMAP4</a> --+
        |
       <strong class="uidshort">IMAP4_stream</strong>
</pre>

<hr />
<pre class="literalblock">
IMAP4 client class over a stream

Instantiate with: IMAP4_stream(command)

        where &quot;command&quot; is a string that can be passed to os.popen2()

for more documentation see the docstring of the parent class IMAP4.

</pre><br /><br />

<!-- ==================== NESTED CLASSES ==================== -->
<a name="section-NestedClasses"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Nested Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-NestedClasses"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="imaplib.IMAP4-class.html">IMAP4</a></code></b>:
      <code><a href="imaplib.IMAP4.abort-class.html">abort</a></code>,
      <code><a href="imaplib.IMAP4.error-class.html">error</a></code>,
      <code><a href="imaplib.IMAP4.readonly-class.html">readonly</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">command</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#open" class="summary-sig-name">open</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">host</span>=<span class="summary-sig-default">global_settings.applications_parent</span>,
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">global_settings.applications_parent</span>)</span><br />
      Setup a stream connection.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.open">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#read" class="summary-sig-name">read</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">size</span>)</span><br />
      Read 'size' bytes from remote.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.read">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#readline" class="summary-sig-name">readline</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Read line from remote.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.readline">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#send" class="summary-sig-name">send</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">data</span>)</span><br />
      Send data to remote.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.send">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="imaplib.IMAP4_stream-class.html#shutdown" class="summary-sig-name">shutdown</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Close I/O established in &quot;open&quot;.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.shutdown">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="imaplib.IMAP4-class.html">IMAP4</a></code></b>:
      <code><a href="imaplib.IMAP4-class.html#__getattr__">__getattr__</a></code>,
      <code><a href="imaplib.IMAP4-class.html#append">append</a></code>,
      <code><a href="imaplib.IMAP4-class.html#authenticate">authenticate</a></code>,
      <code><a href="imaplib.IMAP4-class.html#capability">capability</a></code>,
      <code><a href="imaplib.IMAP4-class.html#check">check</a></code>,
      <code><a href="imaplib.IMAP4-class.html#close">close</a></code>,
      <code><a href="imaplib.IMAP4-class.html#copy">copy</a></code>,
      <code><a href="imaplib.IMAP4-class.html#create">create</a></code>,
      <code><a href="imaplib.IMAP4-class.html#delete">delete</a></code>,
      <code><a href="imaplib.IMAP4-class.html#deleteacl">deleteacl</a></code>,
      <code><a href="imaplib.IMAP4-class.html#expunge">expunge</a></code>,
      <code><a href="imaplib.IMAP4-class.html#fetch">fetch</a></code>,
      <code><a href="imaplib.IMAP4-class.html#getacl">getacl</a></code>,
      <code><a href="imaplib.IMAP4-class.html#getannotation">getannotation</a></code>,
      <code><a href="imaplib.IMAP4-class.html#getquota">getquota</a></code>,
      <code><a href="imaplib.IMAP4-class.html#getquotaroot">getquotaroot</a></code>,
      <code><a href="imaplib.IMAP4-class.html#list">list</a></code>,
      <code><a href="imaplib.IMAP4-class.html#login">login</a></code>,
      <code><a href="imaplib.IMAP4-class.html#login_cram_md5">login_cram_md5</a></code>,
      <code><a href="imaplib.IMAP4-class.html#logout">logout</a></code>,
      <code><a href="imaplib.IMAP4-class.html#lsub">lsub</a></code>,
      <code><a href="imaplib.IMAP4-class.html#myrights">myrights</a></code>,
      <code><a href="imaplib.IMAP4-class.html#namespace">namespace</a></code>,
      <code><a href="imaplib.IMAP4-class.html#noop">noop</a></code>,
      <code><a href="imaplib.IMAP4-class.html#partial">partial</a></code>,
      <code><a href="imaplib.IMAP4-class.html#print_log">print_log</a></code>,
      <code><a href="imaplib.IMAP4-class.html#proxyauth">proxyauth</a></code>,
      <code><a href="imaplib.IMAP4-class.html#recent">recent</a></code>,
      <code><a href="imaplib.IMAP4-class.html#rename">rename</a></code>,
      <code><a href="imaplib.IMAP4-class.html#response">response</a></code>,
      <code><a href="imaplib.IMAP4-class.html#search">search</a></code>,
      <code><a href="imaplib.IMAP4-class.html#select">select</a></code>,
      <code><a href="imaplib.IMAP4-class.html#setacl">setacl</a></code>,
      <code><a href="imaplib.IMAP4-class.html#setannotation">setannotation</a></code>,
      <code><a href="imaplib.IMAP4-class.html#setquota">setquota</a></code>,
      <code><a href="imaplib.IMAP4-class.html#socket">socket</a></code>,
      <code><a href="imaplib.IMAP4-class.html#sort">sort</a></code>,
      <code><a href="imaplib.IMAP4-class.html#status">status</a></code>,
      <code><a href="imaplib.IMAP4-class.html#store">store</a></code>,
      <code><a href="imaplib.IMAP4-class.html#subscribe">subscribe</a></code>,
      <code><a href="imaplib.IMAP4-class.html#thread">thread</a></code>,
      <code><a href="imaplib.IMAP4-class.html#uid">uid</a></code>,
      <code><a href="imaplib.IMAP4-class.html#unsubscribe">unsubscribe</a></code>,
      <code><a href="imaplib.IMAP4-class.html#xatom">xatom</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="imaplib.IMAP4-class.html">IMAP4</a></code></b> (private):
      <code><a href="imaplib.IMAP4-class.html#_CRAM_MD5_AUTH">_CRAM_MD5_AUTH</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_append_untagged">_append_untagged</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_check_bye">_check_bye</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_checkquote">_checkquote</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_command">_command</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_command_complete">_command_complete</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_dump_ur">_dump_ur</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_get_line">_get_line</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_get_response">_get_response</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_get_tagged_response">_get_tagged_response</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_log">_log</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_match">_match</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_mesg">_mesg</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_new_tag">_new_tag</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_quote">_quote</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_simple_command">_simple_command</a></code>,
      <code><a href="imaplib.IMAP4-class.html#_untagged_response">_untagged_response</a></code>
      </p></div>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="imaplib.IMAP4-class.html">IMAP4</a></code></b>:
      <code><a href="imaplib.IMAP4-class.html#mustquote">mustquote</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">command</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  
  <dl class="fields">
    <dt>Overrides:
      IMAP4.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="open"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">open</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">host</span>=<span class="sig-default">global_settings.applications_parent</span>,
        <span class="sig-arg">port</span>=<span class="sig-default">global_settings.applications_parent</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.open">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <pre class="literalblock">
Setup a stream connection.
This connection will be used by the routines:
    read, readline, send, shutdown.

</pre>
  <dl class="fields">
    <dt>Overrides:
      IMAP4.open
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="read"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">read</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">size</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.read">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Read 'size' bytes from remote.
  <dl class="fields">
    <dt>Overrides:
      IMAP4.read
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="readline"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">readline</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.readline">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Read line from remote.
  <dl class="fields">
    <dt>Overrides:
      IMAP4.readline
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="send"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">send</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">data</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.send">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Send data to remote.
  <dl class="fields">
    <dt>Overrides:
      IMAP4.send
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="shutdown"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">shutdown</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="imaplib-pysrc.html#IMAP4_stream.shutdown">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Close I/O established in &quot;open&quot;.
  <dl class="fields">
    <dt>Overrides:
      IMAP4.shutdown
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="web2py.gluon-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Sun Mar  4 22:11:58 2012
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>
